<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_fec_tx: xvoipfec_tx_hw.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_fec_tx
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xvoipfec__tx__hw_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">xvoipfec_tx_hw.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This header file contains identifiers and register-level core functions (or macros) that can be used to access the Xilinx VoIP FEC Transmitter core. </p>
<p>For more information about the operation of this core see the hardware specification and documentation in the higher level driver <a class="el" href="xvoipfec__tx_8h.html" title="This is the main header file for VoIP FEC Transmitter core. ">xvoipfec_tx.h</a> file.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Register access macro definition</div></td></tr>
<tr class="memitem:aee9297b77ff3ac352c8b9618aa9a1a81"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvoipfec__tx__hw_8h.html#aee9297b77ff3ac352c8b9618aa9a1a81">XVoipFEC_TX_In32</a>&#160;&#160;&#160;Xil_In32</td></tr>
<tr class="memdesc:aee9297b77ff3ac352c8b9618aa9a1a81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input Operations.  <a href="#aee9297b77ff3ac352c8b9618aa9a1a81">More...</a><br /></td></tr>
<tr class="separator:aee9297b77ff3ac352c8b9618aa9a1a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02d725adb8af64faf0272bea4d2098fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvoipfec__tx__hw_8h.html#a02d725adb8af64faf0272bea4d2098fd">XVoipFEC_TX_Out32</a>&#160;&#160;&#160;Xil_Out32</td></tr>
<tr class="memdesc:a02d725adb8af64faf0272bea4d2098fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output Operations.  <a href="#a02d725adb8af64faf0272bea4d2098fd">More...</a><br /></td></tr>
<tr class="separator:a02d725adb8af64faf0272bea4d2098fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a829d0e6ea1efad9aa1954ad2b0a0c90f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvoipfec__tx__hw_8h.html#a829d0e6ea1efad9aa1954ad2b0a0c90f">XVoipFEC_TX_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;<a class="el" href="xvoipfec__tx__hw_8h.html#aee9297b77ff3ac352c8b9618aa9a1a81">XVoipFEC_TX_In32</a>((BaseAddress) + ((u32)RegOffset))</td></tr>
<tr class="memdesc:a829d0e6ea1efad9aa1954ad2b0a0c90f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro reads a value from a VoIP FEC Transmitter register.  <a href="#a829d0e6ea1efad9aa1954ad2b0a0c90f">More...</a><br /></td></tr>
<tr class="separator:a829d0e6ea1efad9aa1954ad2b0a0c90f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1b69f3c123878d990801700053378f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvoipfec__tx__hw_8h.html#af1b69f3c123878d990801700053378f0">XVoipFEC_TX_WriteReg</a>(BaseAddress,  RegOffset,  Data)&#160;&#160;&#160;<a class="el" href="xvoipfec__tx__hw_8h.html#a02d725adb8af64faf0272bea4d2098fd">XVoipFEC_TX_Out32</a>((BaseAddress) + ((u32)RegOffset), (u32)(Data))</td></tr>
<tr class="memdesc:af1b69f3c123878d990801700053378f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro writes a value to a VoIP FEC Transmitter register.  <a href="#af1b69f3c123878d990801700053378f0">More...</a><br /></td></tr>
<tr class="separator:af1b69f3c123878d990801700053378f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aee9297b77ff3ac352c8b9618aa9a1a81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee9297b77ff3ac352c8b9618aa9a1a81">&#9670;&nbsp;</a></span>XVoipFEC_TX_In32</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVoipFEC_TX_In32&#160;&#160;&#160;Xil_In32</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input Operations. </p>

</div>
</div>
<a id="a02d725adb8af64faf0272bea4d2098fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02d725adb8af64faf0272bea4d2098fd">&#9670;&nbsp;</a></span>XVoipFEC_TX_Out32</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVoipFEC_TX_Out32&#160;&#160;&#160;Xil_Out32</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Output Operations. </p>

</div>
</div>
<a id="a829d0e6ea1efad9aa1954ad2b0a0c90f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a829d0e6ea1efad9aa1954ad2b0a0c90f">&#9670;&nbsp;</a></span>XVoipFEC_TX_ReadReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVoipFEC_TX_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="xvoipfec__tx__hw_8h.html#aee9297b77ff3ac352c8b9618aa9a1a81">XVoipFEC_TX_In32</a>((BaseAddress) + ((u32)RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro reads a value from a VoIP FEC Transmitter register. </p>
<p>A 32 bit read is performed. If the component is implemented in a smaller width, only the least significant data is read from the register. The most significant data will be read as 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the VoIP FEC Transmitter core instance. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the register (defined at the top of this file).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The 32-bit value of the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="xvoipfec__tx__hw_8h.html#a829d0e6ea1efad9aa1954ad2b0a0c90f" title="This macro reads a value from a VoIP FEC Transmitter register. ">XVoipFEC_TX_ReadReg(u32 BaseAddress, u32 RegOffset)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="xvoipfec__tx_8h.html#aee86488c11ff9cf53549b2332119c282">XVoipFEC_TX_ChannelUpdate()</a>, <a class="el" href="xvoipfec__tx_8h.html#a2c7e5565edd417819b9b882667cd4e31">XVoipFEC_TX_CoreStatisics()</a>, <a class="el" href="xvoipfec__tx_8h.html#ac6ccdcab3de0dd98fa27b38ec6056198">XVoipFEC_TX_CoreStatusRegValue()</a>, <a class="el" href="xvoipfec__tx_8h.html#a47e79a5cffb9655bdae73a1ec67c7a62">XVoipFEC_TX_FECParamsRegValue()</a>, <a class="el" href="xvoipfec__tx_8h.html#ac0466a9c6025586fc45847f0f7ffe573">XVoipFEC_TX_SetFEC_D()</a>, <a class="el" href="xvoipfec__tx_8h.html#aa471d8cbbc8f8f0644796bd90b5ce1f1">XVoipFEC_TX_SetFEC_L()</a>, <a class="el" href="xvoipfec__tx_8h.html#aef39569b5def521ba026c358b7b4dfa9">XVoipFEC_TX_SetFECMode()</a>, <a class="el" href="xvoipfec__tx_8h.html#a168ca60724a76b1f621e2c823675bf10">XVoipFEC_TX_SetFECNonBlockAllign()</a>, and <a class="el" href="xvoipfec__tx_8h.html#a257faccae73328ce6258bbd9bb1c98e4">XVoipFEC_TX_SoftReset()</a>.</p>

</div>
</div>
<a id="af1b69f3c123878d990801700053378f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1b69f3c123878d990801700053378f0">&#9670;&nbsp;</a></span>XVoipFEC_TX_WriteReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVoipFEC_TX_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="xvoipfec__tx__hw_8h.html#a02d725adb8af64faf0272bea4d2098fd">XVoipFEC_TX_Out32</a>((BaseAddress) + ((u32)RegOffset), (u32)(Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro writes a value to a VoIP FEC Transmitter register. </p>
<p>A 32 bit write is performed. If the component is implemented in a smaller width, only the least significant data is written.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the VoIP FEC Transmitter core instance. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the register (defined at the top of this file) to be written. </td></tr>
    <tr><td class="paramname">Data</td><td>is the 32-bit value to write into the register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="xvoipfec__tx__hw_8h.html#af1b69f3c123878d990801700053378f0" title="This macro writes a value to a VoIP FEC Transmitter register. ">XVoipFEC_TX_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="xvoipfec__tx_8h.html#af08cdc845ae3021bcfba68fd2d3873b0">XVoipFEC_ChannelAccess()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
